home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr37 / aussiebb.zip / MAILSCAN.ZIP / MAILSCAN.DOC < prev    next >
Text File  |  1992-06-13  |  8KB  |  185 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                               MailScan Utility
  8.                            for the Verifier Door
  9.                                 Version 1.0
  10.  
  11.  
  12.                              By: Lance Williams
  13.                                Kadet PCBoard
  14.                                  Camden, NY
  15.                                (315) 245-3815
  16.                              USR Dual Standard
  17.  
  18.  
  19.  
  20.  
  21.  
  22.          MailScan is a utility for registered versions of the Verifier Door
  23.     and Mailing  List  Utility  package.   This  program will search for an
  24.     entry in the MAILLIST.DAT file  for  the  current  user,  and  if found
  25.     create a display file to be shown to the user.  The program is designed
  26.     to be run in your $$LOGON.BAT file, and you can then  display  the file
  27.     created within  the  caller's security file using the PCBoard %filespec
  28.     macro.  It is quite fast, taking  only  3-5  seconds  to  search  a 500
  29.     record file and create the display screen on a 386-25 under DESQview (2
  30.     nodes running).  The program keeps track of the last  date  checked  in
  31.     the MAILLIST.DAT  file,  and  creates  the  display file either yearly,
  32.     quarterly or monthly, depending on your configuration setting.  If it's
  33.     not time for a file to be created,  a  zero length file will be created
  34.     in it's place.
  35.  
  36.  
  37.     Files used by the program:
  38.  
  39.     MAILSCAN.EXE   The main executable program.
  40.     MAILSCAN.CFG   The configuration file, one for each node, I use
  41.                         SCAN1.CFG and SCAN2.CFG.
  42.     MAILSCAN.DAT   The   "master   copy"  of  the  display   screen,   with
  43.                         substitution macros for information.
  44.     $$LOGON.BAT    The  batch  processing file that PCBoard executes when a
  45.                         caller logs onto the system.
  46.  
  47.  
  48.     Using the Program:
  49.  
  50.          The MAILSCAN.EXE file *MUST*  be  run  from  the directory you run
  51.     your Verifier Door.  It has to be able to access your MAILLIST.DAT file
  52.     to get information for the current user.  Run the MAILSCAN.EXE  program
  53.     with the  proper  configuration  file from within your $$LOGON.BAT file
  54.     for PCBoard.  The program will create  a  screen from your MAILSCAN.DAT
  55.     file, which  is  a master copy which contains substitution  macros  for
  56.     placement of the address information.
  57.  
  58.        __________________________________________________________________
  59.         Kadet PCBoard, (315) 245-3815, USR Dual Std.              Page 1
  60.  
  61.  
  62.        MailScan Utility for The Verifier Door      Lance Williams, Author
  63.  
  64.  
  65.     The following PCBoard style macros are available to this program:
  66.  
  67.     Macro          Description
  68.     ─────────────  ──────────────────────────────────────────────────
  69.     @MAILNAME@     This is the Mailing Name for the current user.
  70.     @MAILADDRESS@  This is the Mailing Address for the current user.
  71.     @MAILCITY@     This is the City, State, ZIP for the current user.
  72.  
  73.     The master copy of the display copy *MUST* be named MAILSCAN.DAT.  Only
  74.     the above  macros  are  available.  This is for fastest processing.  Of
  75.     course, since it is a PCBoard display  screen,  any PCBoard @macro@ can
  76.     also be used, they will be processed when PCBoard displays the file.
  77.  
  78.  
  79.     Configuration File Format:
  80.  
  81.          There must be a separate configuration file for  each node you are
  82.     running MAILSCAN  on.   The configuration file is the only command line
  83.     parameter for the program.  The configuration  file  has  the following
  84.     format:
  85.  
  86.     Line 1:  Path/Filename of this node's PCBOARD.SYS file.
  87.     Line 2:  System Name (Same as in VERIFIER.CFG)
  88.     Line 3:  Sysop's First Name (Same as in VERIFIER.CFG)
  89.     Line 4:  Sysop's Last Name (Same as in VERIFIER.CFG)
  90.     Line 5:  Registration Number
  91.     Line 6:  How often to create the address information screen.
  92.                 This can be one of the following:
  93.                    YEAR:    Checks yearly.
  94.                    QUARTER: Checks every 3 months
  95.                    MONTH:   Checks monthly.
  96.     Line 7:  Path/filename of the display file to write
  97.                 For multi-node  operations, I use the same  filename,  with
  98.                 different path  information  so each node doesn't overwrite
  99.                 the other node's information.  I save them into identically
  100.                 named subdirectories off the default PCBoard node directory
  101.                 so you can access them easily with the security files.  IE:
  102.                      Node 1: C:\PCB\GEN\ADDRESS
  103.                      Node 2: C:\PCB2\GEN\ADDRESS
  104.  
  105.     Sample Configuration Files:
  106.  
  107.     SCAN1.CFG:                           SCAN2.CFG
  108.  
  109.     C:\PCB\PCBOARD.SYS                   C:\PCB2\PCBOARD.SYS
  110.     Kadet PCBoard                        Kadet PCBoard
  111.     Lance                                Lance
  112.     Williams                             Williams
  113.     0                                    0
  114.     QUARTER                              QUARTER
  115.     C:\PCB\GEN\ADDRESS                   C:\PCB2\GEN\ADDRESS
  116.  
  117.  
  118.  
  119.        __________________________________________________________________
  120.  
  121.         Kadet PCBoard, (315) 245-3815, USR Dual Std.              Page 2
  122.  
  123.        MailScan Utility for The Verifier Door      Lance Williams, Author
  124.  
  125.  
  126.     Having PCBoard Display the File:
  127.  
  128.          If you  use  the %Filespec macro in your security screens for your
  129.     users, the created screen will be  displayed  to  the  user.   See your
  130.     PCBoard 14.5a  documentation for usage of the %Filespec  variable.   By
  131.     using an  incomplete pathname to display the file, I don't have to have
  132.     separate security files for each node.  Here is an example of I display
  133.     the information screen:
  134.  
  135.     User Security File:
  136.  
  137.     @QOFF@
  138.     %C:\PCB\GEN\STATS.TXT           User Status screen I have.
  139.     @WAIT@
  140.     %GEN\ADDRESS                    Screen created by MAILSCAN.EXE
  141.     @QON@
  142.  
  143.     Notes:
  144.  
  145.          I have found this utility useful  in  having  users  update  their
  146.     mailing address when they have moved.  If you use it,  you may find the
  147.     same thing.   If you have any problems with it, let me know.  Remember,
  148.     this program only works with registered versions.
  149.  
  150.  
  151.     License Agreement
  152.  
  153.          The MailScan Utility ("The Software")  is  COPYRIGHT 1992 by Lance
  154.     Williams, ALL RIGHTS RESERVED.  You may not engage in, nor permit third
  155.     parties to engage in, any of the following :
  156.  
  157.             A)   Making alterations of any kind in the software.
  158.             B)   ATTEMPTING TO DISASSEMBLE, DECOMPILE, OR  REVERSE ENGINEER
  159.                  THE SOFTWARE OR THE FILES IT GENERATES IN ANY WAY.
  160.             C)   Granting  sub-licenses,  lease  or  other  rights  in  the
  161.                  software to others.
  162.             D)   This release is SHAREWARE,  if  you  continue  to use this
  163.                  package for more than 3 weeks, you must  register  it with
  164.                  the author.
  165.  
  166.          The author of the software grants you a license to use this
  167.     software as  long  as  you meet the above conditions.  Any violation of
  168.     the above conditions will result in  the termination of your license to
  169.     use this software.  Upon termination of this license  for  any  reason,
  170.     you must  stop  using the software and destroy all copies of it in your
  171.     possession immediately.  In addition,  the author reserves the right to
  172.     cancel your  license to use this software at any time  for  any  reason
  173.     that he sees fit.
  174.  
  175.          The author  of this software is not liable for damages suffered as
  176.     a result of the improper use, proper  use,  or  inability  to  use this
  177.     software.  This type of disclaimer is prohibited by law in some states,
  178.     and is therefore void in those states.
  179.  
  180.  
  181.        __________________________________________________________________
  182.         Kadet PCBoard, (315) 245-3815, USR Dual Std.              Page 3
  183.  
  184.  
  185.